| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

Public Member Functions | List of all members
nkDebug::TestRunException Class Referencefinal

An exception raised when a test fails during an execution. More...

## Public Member Functions
| TestRunException () noexcept
| TestRunException (nkMemory::StringView rejectionReason) noexcept
| TestRunException (nkMemory::StringView rejectionReason, nkMemory::BufferCast< TestStackLevel > rejectionStack) noexcept
nkMemory::StringView | getRejectionReason () const
nkMemory::BufferView< TestStackLevel > | getRejectionStack () const

## Detailed Description

An exception raised when a test fails during an execution.

## Constructor & Destructor Documentation

## ◆ TestRunException() [1/3]

nkDebug::TestRunException::TestRunException | ( |  | ) |
| noexcept

Default constructor, without message.

## ◆ TestRunException() [2/3]

nkDebug::TestRunException::TestRunException | ( | nkMemory::StringView | rejectionReason | ) |
| noexcept

Messaged constructor.

Parameters

  rejectionReason | The reason for the test rejection.

## ◆ TestRunException() [3/3]

nkDebug::TestRunException::TestRunException | ( | nkMemory::StringView | rejectionReason,
|  | nkMemory::BufferCast< TestStackLevel > | rejectionStack
| ) |  |
| noexcept

Messaged constructor, with a custom stack trace.

Parameters

  rejectionReason | The reason for the test rejection.
  rejectionStack | The stack to attach to the exception.

## Member Function Documentation

## ◆ getRejectionReason()

nkMemory::StringView nkDebug::TestRunException::getRejectionReason | ( |  | ) | const

Returns
  The rejection reason.

## ◆ getRejectionStack()

nkMemory::BufferView<TestStackLevel> nkDebug::TestRunException::getRejectionStack | ( |  | ) | const

Returns
  The stack at the moment of the exception.

The documentation for this class was generated from the following file:

- Documentation/Headers/NilkinsDebug/Testing/Data/TestRunException.h